/**
 * Copyright (c) 2008 - TheNittyGritty - Thomas Brekelmans
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package nl.thenittygritty.amc 
{
	import flash.display.MovieClip;
	import flash.events.Event;		

	/**
	 * Module.
	 */
	public class Module extends MovieClip
	{
		/**
		 * Creates a new Module.
		 */
		public function Module() 
		{
		}
		
		/**
		 * Dispatches a ModuleEvent.LOAD_COMPLETE event. 
		 * Call this method from yout subclass of module as soon as the module 
		 * is done initialising and all its public methods are ready 
		 * (this is usually at the end of your init method).
		 */
		protected function notifyModuleIsInitialised():void
		{
			this.addEventListener(Event.ENTER_FRAME, onFrameEnter);
		}
		
		/**
		 * Actually dispatches the ModuleEvent.LOAD_COMPLETE event (after 1 
		 * frame is passed) and removes the enter frame event listener.
		 */
		private function onFrameEnter(e:Event):void
		{
			dispatchEvent(new ModuleEvent(ModuleEvent.LOAD_COMPLETE, this));
			
			this.removeEventListener(Event.ENTER_FRAME, onFrameEnter);
		}	

		/**
		 * Returns the name of the class in a String.
		 */
		override public function toString():String 
		{
			return "Module";
		}
	}
}
